<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Nodes stats API | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="cluster.html" title="Cluster APIs">
<link rel="prev" href="cluster-nodes-reload-secure-settings.html" title="Nodes reload secure settings API">
<link rel="next" href="cluster-pending.html" title="Pending cluster tasks API">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cluster.html">Cluster APIs</a></span>
»
<span class="breadcrumb-node">Nodes stats API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cluster-nodes-reload-secure-settings.html">« Nodes reload secure settings API</a>
</span>
<span class="next">
<a href="cluster-pending.html">Pending cluster tasks API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cluster-nodes-stats"></a>Nodes stats API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns cluster nodes statistics.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_nodes/stats</code><br></p>
<p><code class="literal">GET /_nodes/&lt;node_id&gt;/stats</code><br></p>
<p><code class="literal">GET/_nodes/stats/&lt;metric&gt;</code><br></p>
<p><code class="literal">GET/_nodes/&lt;node_id&gt;/stats/&lt;metric&gt;</code><br></p>
<p><code class="literal">GET /_nodes/stats/&lt;metric&gt;/&lt;index_metric&gt;</code><br></p>
<p><code class="literal">GET /_nodes/&lt;node_id&gt;/stats/&lt;metric&gt;/&lt;index_metric&gt;</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster.</p>
<p>All the nodes selective options are explained <a class="xref" href="cluster.html#cluster-nodes" title="Node specification">here</a>.</p>
<p>By default, all stats are returned. You can limit the returned information by
using metrics.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;metric&gt;</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Limits the information returned to the specific metrics.
A comma-separated list of the following options:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">adaptive_selection</code>
</span>
</dt>
<dd>
Statistics about <a class="xref" href="search.html#search-adaptive-replica" title="Adaptive Replica Selection">adaptive replica selection</a>.
</dd>
<dt>
<span class="term">
<code class="literal">breaker</code>
</span>
</dt>
<dd>
Statistics about the field data circuit breaker.
</dd>
<dt>
<span class="term">
<code class="literal">discovery</code>
</span>
</dt>
<dd>
Statistics about the discovery.
</dd>
<dt>
<span class="term">
<code class="literal">fs</code>
</span>
</dt>
<dd>
File system information, data path, free disk space, read/write
stats.
</dd>
<dt>
<span class="term">
<code class="literal">http</code>
</span>
</dt>
<dd>
HTTP connection information.
</dd>
<dt>
<span class="term">
<code class="literal">indices</code>
</span>
</dt>
<dd>
Indices stats about size, document count, indexing and deletion times,
search times, field cache size, merges and flushes.
</dd>
<dt>
<span class="term">
<code class="literal">ingest</code>
</span>
</dt>
<dd>
Statistics about ingest preprocessing.
</dd>
<dt>
<span class="term">
<code class="literal">jvm</code>
</span>
</dt>
<dd>
JVM stats, memory pool information, garbage collection, buffer
pools, number of loaded/unloaded classes.
</dd>
<dt>
<span class="term">
<code class="literal">os</code>
</span>
</dt>
<dd>
Operating system stats, load average, mem, swap.
</dd>
<dt>
<span class="term">
<code class="literal">process</code>
</span>
</dt>
<dd>
Process statistics, memory consumption, cpu usage, open
file descriptors.
</dd>
<dt>
<span class="term">
<code class="literal">thread_pool</code>
</span>
</dt>
<dd>
Statistics about each thread pool, including current size, queue and
rejected tasks.
</dd>
<dt>
<span class="term">
<code class="literal">transport</code>
</span>
</dt>
<dd>
Transport statistics about sent and received bytes in cluster
communication.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">&lt;index_metric&gt;</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Limit the information returned for <code class="literal">indices</code> metric to
the specific index metrics. It can be used only if <code class="literal">indices</code> (or <code class="literal">all</code>)
metric is specified. Supported metrics are:
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">completion</code>
</li>
<li class="listitem">
<code class="literal">docs</code>
</li>
<li class="listitem">
<code class="literal">fielddata</code>
</li>
<li class="listitem">
<code class="literal">flush</code>
</li>
<li class="listitem">
<code class="literal">get</code>
</li>
<li class="listitem">
<code class="literal">indexing</code>
</li>
<li class="listitem">
<code class="literal">merge</code>
</li>
<li class="listitem">
<code class="literal">query_cache</code>
</li>
<li class="listitem">
<code class="literal">recovery</code>
</li>
<li class="listitem">
<code class="literal">refresh</code>
</li>
<li class="listitem">
<code class="literal">request_cache</code>
</li>
<li class="listitem">
<code class="literal">search</code>
</li>
<li class="listitem">
<code class="literal">segments</code>
</li>
<li class="listitem">
<code class="literal">store</code>
</li>
<li class="listitem">
<code class="literal">translog</code>
</li>
<li class="listitem">
<code class="literal">warmer</code>
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">&lt;node_id&gt;</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of node IDs or names used to limit
returned information.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">completion_fields</code>
</span>
</dt>
<dd>
(Optional, string)
Comma-separated list or wildcard expressions of fields
to include in <code class="literal">fielddata</code> and <code class="literal">suggest</code> statistics.
</dd>
<dt>
<span class="term">
<code class="literal">fielddata_fields</code>
</span>
</dt>
<dd>
(Optional, string)
Comma-separated list or wildcard expressions of fields
to include in <code class="literal">fielddata</code> statistics.
</dd>
<dt>
<span class="term">
<code class="literal">fields</code>
</span>
</dt>
<dd>
<p>(Optional, string)
Comma-separated list or wildcard expressions of fields
to include in the statistics.</p>
<p>Used as the default list
unless a specific field list is provided
in the <code class="literal">completion_fields</code> or <code class="literal">fielddata_fields</code> parameters.</p>
</dd>
<dt>
<span class="term">
<code class="literal">groups</code>
</span>
</dt>
<dd>
(Optional, string)
Comma-separated list of search groups
to include in the <code class="literal">search</code> statistics.
</dd>
<dt>
<span class="term">
<code class="literal">level</code>
</span>
</dt>
<dd>
<p>(Optional, string)
Indicates whether statistics are aggregated
at the cluster, index, or shard level.</p>
<p>Valid values are:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">cluster</code>
</li>
<li class="listitem">
<code class="literal">indices</code>
</li>
<li class="listitem">
<code class="literal">shards</code>
</li>
</ul>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">types</code>
</span>
</dt>
<dd>
(Optional, string) A comma-separated list of document types for the
<code class="literal">indexing</code> index metric.
</dd>
<dt>
<span class="term">
<code class="literal">master_timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">include_segment_file_sizes</code>
</span>
</dt>
<dd>
(Optional, boolean)
If <code class="literal">true</code>, the call reports the aggregated disk usage of
each one  of the Lucene index files (only applies if segment stats are
requested). Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">_nodes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the number of nodes selected by the request.
</p>
<details open>
<summary class="title">Properties of <code class="literal">_nodes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of nodes selected by the request.
</dd>
<dt>
<span class="term">
<code class="literal">successful</code>
</span>
</dt>
<dd>
(integer)
Number of nodes that responded successfully to the request.
</dd>
<dt>
<span class="term">
<code class="literal">failed</code>
</span>
</dt>
<dd>
(integer)
Number of nodes that rejected the request or failed to respond. If this value
is not <code class="literal">0</code>, a reason for the rejection or failure is included in the response.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">cluster_name</code>
</span>
</dt>
<dd>
(string)
Name of the cluster. Based on the <a class="xref" href="cluster.name.html" title="cluster.name"><code class="literal">cluster.name</code></a> setting.
</dd>
<dt>
<span class="term">
<code class="literal">nodes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the nodes selected by the request.
</p>
<details open>
<summary class="title">Properties of <code class="literal">nodes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;node_id&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;node_id&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
Time the node stats were collected for this response. Recorded in milliseconds
since the <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix Epoch</a>.
</dd>
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Human-readable identifier for the node. Based on the <a class="xref" href="node.name.html" title="node.name"><code class="literal">node.name</code></a> setting.
</dd>
<dt>
<span class="term">
<code class="literal">transport_address</code>
</span>
</dt>
<dd>
(string)
Host and port for the <a class="xref" href="modules-transport.html" title="Transport">transport layer</a>, used for internal
communication between nodes in a cluster.
</dd>
<dt>
<span class="term">
<code class="literal">host</code>
</span>
</dt>
<dd>
(string)
Network host for the node, based on the <a class="xref" href="network.host.html" title="network.host"><code class="literal">network.host</code></a> setting.
</dd>
<dt>
<span class="term">
<code class="literal">ip</code>
</span>
</dt>
<dd>
(string)
IP address and port for the node.
</dd>
<dt>
<span class="term">
<code class="literal">roles</code>
</span>
</dt>
<dd>
(array of strings)
Roles assigned to the node. See <a class="xref" href="modules-node.html" title="Node">Node</a>.
</dd>
<dt>
<span class="term">
<code class="literal">attributes</code>
</span>
</dt>
<dd>
(object)
Contains a list of attributes for the node.
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-indices"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about indices with shards assigned to the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">indices</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">docs</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about documents across all primary shards assigned to the
node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">docs</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of non-deleted documents in the segment, such as <code class="literal">25</code>. This
number is based on Lucene documents and may include documents from
<a class="xref" href="nested.html" title="Nested datatype">nested</a> fields.
</dd>
<dt>
<span class="term">
<code class="literal">deleted</code>
</span>
</dt>
<dd>
(integer)
Number of deleted documents in the segment, such as <code class="literal">0</code>. This number
is based on Lucene documents. Elasticsearch reclaims the disk space of deleted Lucene
documents when a segment is merged.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">store</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the size of shards assigned to the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">store</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total size of all shards assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size, in bytes, of all shards assigned to the node.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">indexing</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about indexing operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">indexing</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">index_total</code>
</span>
</dt>
<dd>
(integer)
Total number of indexing operations.
</dd>
<dt>
<span class="term">
<code class="literal">index_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing indexing operations.
</dd>
<dt>
<span class="term">
<code class="literal">index_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing indexing operations.
</dd>
<dt>
<span class="term">
<code class="literal">index_current</code>
</span>
</dt>
<dd>
(integer)
Number of indexing operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">index_failed</code>
</span>
</dt>
<dd>
(integer)
Number of failed indexing operations.
</dd>
<dt>
<span class="term">
<code class="literal">delete_total</code>
</span>
</dt>
<dd>
(integer)
Total number of deletion operations.
</dd>
<dt>
<span class="term">
<code class="literal">delete_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing deletion operations.
</dd>
<dt>
<span class="term">
<code class="literal">delete_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing deletion operations.
</dd>
<dt>
<span class="term">
<code class="literal">delete_current</code>
</span>
</dt>
<dd>
(integer)
Number of deletion operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">noop_update_total</code>
</span>
</dt>
<dd>
(integer)
Total number of noop operations.
</dd>
<dt>
<span class="term">
<code class="literal">is_throttled</code>
</span>
</dt>
<dd>
(boolean)
Number of times
operations were throttled.
</dd>
<dt>
<span class="term">
<code class="literal">throttle_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent throttling operations.
</dd>
<dt>
<span class="term">
<code class="literal">throttle_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent throttling operations.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">get</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about get operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">get</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of get operations.
</dd>
<dt>
<span class="term">
<code class="literal">getTime</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing get operations.
</dd>
<dt>
<span class="term">
<code class="literal">time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing get operations.
</dd>
<dt>
<span class="term">
<code class="literal">exists_total</code>
</span>
</dt>
<dd>
(integer)
Total number of successful get operations.
</dd>
<dt>
<span class="term">
<code class="literal">exists_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing successful get operations.
</dd>
<dt>
<span class="term">
<code class="literal">exists_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing successful get operations.
</dd>
<dt>
<span class="term">
<code class="literal">missing_total</code>
</span>
</dt>
<dd>
(integer)
Total number of failed get operations.
</dd>
<dt>
<span class="term">
<code class="literal">missing_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing failed get operations.
</dd>
<dt>
<span class="term">
<code class="literal">missing_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing failed get operations.
</dd>
<dt>
<span class="term">
<code class="literal">current</code>
</span>
</dt>
<dd>
(integer)
Number of get operations currently running.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">search</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about search operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">search</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">open_contexts</code>
</span>
</dt>
<dd>
(integer)
Number of open search contexts.
</dd>
<dt>
<span class="term">
<code class="literal">query_total</code>
</span>
</dt>
<dd>
(integer)
Total number of query operations.
</dd>
<dt>
<span class="term">
<code class="literal">query_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing query operations.
</dd>
<dt>
<span class="term">
<code class="literal">query_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing query operations.
</dd>
<dt>
<span class="term">
<code class="literal">query_current</code>
</span>
</dt>
<dd>
(integer)
Number of query operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">fetch_total</code>
</span>
</dt>
<dd>
(integer)
Total number of fetch operations.
</dd>
<dt>
<span class="term">
<code class="literal">fetch_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing fetch operations.
</dd>
<dt>
<span class="term">
<code class="literal">fetch_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing fetch operations.
</dd>
<dt>
<span class="term">
<code class="literal">fetch_current</code>
</span>
</dt>
<dd>
(integer)
Number of fetch operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">scroll_total</code>
</span>
</dt>
<dd>
(integer)
Total number of scroll operations.
</dd>
<dt>
<span class="term">
<code class="literal">scroll_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing scroll operations.
</dd>
<dt>
<span class="term">
<code class="literal">scroll_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing scroll operations.
</dd>
<dt>
<span class="term">
<code class="literal">scroll_current</code>
</span>
</dt>
<dd>
(integer)
Number of scroll operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">suggest_total</code>
</span>
</dt>
<dd>
(integer)
Total number of suggest operations.
</dd>
<dt>
<span class="term">
<code class="literal">suggest_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent performing suggest operations.
</dd>
<dt>
<span class="term">
<code class="literal">suggest_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
spent performing suggest operations.
</dd>
<dt>
<span class="term">
<code class="literal">suggest_current</code>
</span>
</dt>
<dd>
(integer)
Number of suggest operations currently running.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">merges</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about merge operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">merges</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">current</code>
</span>
</dt>
<dd>
(integer)
Number of merge operations currently running.
</dd>
<dt>
<span class="term">
<code class="literal">current_docs</code>
</span>
</dt>
<dd>
(integer)
Number of document merges currently running.
</dd>
<dt>
<span class="term">
<code class="literal">current_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory used performing current document merges.
</dd>
<dt>
<span class="term">
<code class="literal">current_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, used performing current document merges.
</dd>
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_docs</code>
</span>
</dt>
<dd>
(integer)
Total number of merged documents.
</dd>
<dt>
<span class="term">
<code class="literal">total_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total size of document merges.
</dd>
<dt>
<span class="term">
<code class="literal">total_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size of document merges in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">total_stopped_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent stopping merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_stopped_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent stopping merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_throttled_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent throttling merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_throttled_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent throttling merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_auto_throttle</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of automatically throttled merge operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_auto_throttle_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of automatically throttled merge operations.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">refresh</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about refresh operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">refresh</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of refresh operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing refresh operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing refresh operations.
</dd>
<dt>
<span class="term">
<code class="literal">external_total</code>
</span>
</dt>
<dd>
(integer)
Total number of external refresh operations.
</dd>
<dt>
<span class="term">
<code class="literal">external_total_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing external operations.
</dd>
<dt>
<span class="term">
<code class="literal">external_total_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing external operations.
</dd>
<dt>
<span class="term">
<code class="literal">listeners</code>
</span>
</dt>
<dd>
(integer)
Number of refresh listeners.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">flush</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about flush operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">flush</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Number of flush operations.
</dd>
<dt>
<span class="term">
<code class="literal">periodic</code>
</span>
</dt>
<dd>
(integer)
Number of flush periodic operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing flush operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing flush operations.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">warmer</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about index warming operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">warmer</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">current</code>
</span>
</dt>
<dd>
(integer)
Number of active index warmers.
</dd>
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of index warmers.
</dd>
<dt>
<span class="term">
<code class="literal">total_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent performing index warming operations.
</dd>
<dt>
<span class="term">
<code class="literal">total_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds
spent performing index warming operations.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">query_cache</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the query cache across all shards assigned to the
node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">query_cache</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">memory_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for the query cache across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">memory_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for the query cache across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">total_count</code>
</span>
</dt>
<dd>
(integer)
Total count of hits, misses, and cached queries
in the query cache.
</dd>
<dt>
<span class="term">
<code class="literal">hit_count</code>
</span>
</dt>
<dd>
(integer)
Number of query cache hits.
</dd>
<dt>
<span class="term">
<code class="literal">miss_count</code>
</span>
</dt>
<dd>
(integer)
Number of query cache misses.
</dd>
<dt>
<span class="term">
<code class="literal">cache_size</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of the query cache.
</dd>
<dt>
<span class="term">
<code class="literal">cache_count</code>
</span>
</dt>
<dd>
(integer)
Count of queries
in the query cache.
</dd>
<dt>
<span class="term">
<code class="literal">evictions</code>
</span>
</dt>
<dd>
(integer)
Number of query cache evictions.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">fielddata</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the field data cache across all shards
assigned to the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">fielddata</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">memory_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for the field data cache across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">memory_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for the field data cache across all
shards assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">evictions</code>
</span>
</dt>
<dd>
(integer)
Number of fielddata evictions.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">completion</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about completions across all shards assigned to the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">completion</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for completion across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for completion across all shards assigned
to the node.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">segments</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about segments across all shards assigned to the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">segments</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of segments.
</dd>
<dt>
<span class="term">
<code class="literal">memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for segments across all shards assigned to the
node.
</dd>
<dt>
<span class="term">
<code class="literal">memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for segments across all shards assigned
to the node.
</dd>
<dt>
<span class="term">
<code class="literal">terms_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for terms across all shards assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">terms_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for terms across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">stored_fields_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for stored fields across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">stored_fields_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for stored fields across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">term_vectors_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for term vectors across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">term_vectors_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for term vectors across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">norms_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for normalization factors across all shards assigned
to the node.
</dd>
<dt>
<span class="term">
<code class="literal">norms_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for normalization factors across all
shards assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">points_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for points across all shards assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">points_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for points across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">doc_values_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used for doc values across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">doc_values_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used for doc values across all shards assigned
to the node.
</dd>
<dt>
<span class="term">
<code class="literal">index_writer_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used by all index writers across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">index_writer_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used by all index writers across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">version_map_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used by all version maps across all shards assigned to
the node.
</dd>
<dt>
<span class="term">
<code class="literal">version_map_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used by all version maps across all shards
assigned to the node.
</dd>
<dt>
<span class="term">
<code class="literal">fixed_bit_set</code>
</span>
</dt>
<dd>
<p>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of memory used by fixed bit sets across all shards assigned to
the node.
</p>
<p>Fixed bit sets are used for nested object field types and
type filters for <a class="xref" href="parent-join.html" title="Join datatype">join</a> fields.</p>
</dd>
<dt>
<span class="term">
<code class="literal">fixed_bit_set_memory_in_bytes</code>
</span>
</dt>
<dd>
<p>
(integer)
Total amount of memory, in bytes, used by fixed bit sets across all shards
assigned to the node.
</p>
<p>Fixed bit sets are used for nested object field types and
type filters for <a class="xref" href="parent-join.html" title="Join datatype">join</a> fields.</p>
</dd>
<dt>
<span class="term">
<code class="literal">max_unsafe_auto_id_timestamp</code>
</span>
</dt>
<dd>
(integer)
Time of the most recently retried indexing request. Recorded in milliseconds
since the <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix Epoch</a>.
</dd>
<dt>
<span class="term">
<code class="literal">file_sizes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the size of the segment file.
</p>
<details open>
<summary class="title">Properties of <code class="literal">file_sizes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of the segment file.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes,
of the segment file.
</dd>
<dt>
<span class="term">
<code class="literal">description</code>
</span>
</dt>
<dd>
(string)
Description of the segment file.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">translog</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about transaction log operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">translog</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">operations</code>
</span>
</dt>
<dd>
(integer)
Number of transaction log operations.
</dd>
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of the transaction log.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of the transaction log.
</dd>
<dt>
<span class="term">
<code class="literal">uncommitted_operations</code>
</span>
</dt>
<dd>
(integer)
Number of uncommitted transaction log operations.
</dd>
<dt>
<span class="term">
<code class="literal">uncommitted_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of uncommitted transaction log operations.
</dd>
<dt>
<span class="term">
<code class="literal">uncommitted_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of uncommitted transaction log operations.
</dd>
<dt>
<span class="term">
<code class="literal">earliest_last_modified_age</code>
</span>
</dt>
<dd>
(integer)
Earliest last modified age
for the transaction log.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">request_cache</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the request cache across all shards assigned to the
node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">request_cache</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">memory_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory used by the request cache.
</dd>
<dt>
<span class="term">
<code class="literal">memory_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, used by the request cache.
</dd>
<dt>
<span class="term">
<code class="literal">evictions</code>
</span>
</dt>
<dd>
(integer)
Number of request cache operations.
</dd>
<dt>
<span class="term">
<code class="literal">hit_count</code>
</span>
</dt>
<dd>
(integer)
Number of request cache hits.
</dd>
<dt>
<span class="term">
<code class="literal">miss_count</code>
</span>
</dt>
<dd>
(integer)
Number of request cache misses.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">recovery</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about recovery operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">recovery</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">current_as_source</code>
</span>
</dt>
<dd>
(integer)
Number of recoveries
that used an index shard as a source.
</dd>
<dt>
<span class="term">
<code class="literal">current_as_target</code>
</span>
</dt>
<dd>
(integer)
Number of recoveries
that used an index shard as a target.
</dd>
<dt>
<span class="term">
<code class="literal">throttle_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time by which recovery operations were delayed due to throttling.
</dd>
<dt>
<span class="term">
<code class="literal">throttle_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time in milliseconds
recovery operations were delayed due to throttling.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-os"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">os</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the operating system for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">os</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
Last time the operating system statistics were refreshed. Recorded in
milliseconds since the <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix Epoch</a>.
</dd>
<dt>
<span class="term">
<code class="literal">cpu</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about CPU usage for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cpu</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">percent</code>
</span>
</dt>
<dd>
(integer)
Recent CPU usage for the whole system, or <code class="literal">-1</code> if not supported.
</dd>
<dt>
<span class="term">
<code class="literal">load_average</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about load averages on the system.
</p>
<details open>
<summary class="title">Properties of <code class="literal">load_average</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">1m</code>
</span>
</dt>
<dd>
(float)
One-minute load average on the system (field is not present if one-minute load
average is not available).
</dd>
<dt>
<span class="term">
<code class="literal">5m</code>
</span>
</dt>
<dd>
(float)
Five-minute load average on the system (field is not present if five-minute load
average is not available).
</dd>
<dt>
<span class="term">
<code class="literal">15m</code>
</span>
</dt>
<dd>
(float)
Fifteen-minute load average on the system (field is not present if
fifteen-minute load average is not available).
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">mem</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory usage for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mem</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of physical memory.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of physical memory in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of free physical memory.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of free physical memory in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of used physical memory.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of used physical memory in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">free_percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of free memory.
</dd>
<dt>
<span class="term">
<code class="literal">used_percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of used memory.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">swap</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about swap space for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">swap</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of swap space.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of swap space in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of free swap space.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of free swap space in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of used swap space.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of used swap space in bytes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">cgroup</code> (Linux only)
</span>
</dt>
<dd>
<p>
(object)
Contains cgroup statistics for the node.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>For the cgroup stats to be visible, cgroups must be compiled into the
kernel, the <code class="literal">cpu</code> and <code class="literal">cpuacct</code> cgroup subsystems must be configured and stats
must be readable from <code class="literal">/sys/fs/cgroup/cpu</code> and <code class="literal">/sys/fs/cgroup/cpuacct</code>.</p>
</div>
</div>
<details open>
<summary class="title">Properties of <code class="literal">cgroup</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">cpuacct</code> (Linux only)
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about <code class="literal">cpuacct</code> control group for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cpuacct</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">control_group</code> (Linux only)
</span>
</dt>
<dd>
(string)
The <code class="literal">cpuacct</code> control group to which the Elasticsearch process belongs.
</dd>
<dt>
<span class="term">
<code class="literal">usage_nanos</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup
as the Elasticsearch process.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">cpu</code> (Linux only)
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about <code class="literal">cpu</code> control group for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cpu</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">control_group</code> (Linux only)
</span>
</dt>
<dd>
(string)
The <code class="literal">cpu</code> control group to which the Elasticsearch process belongs.
</dd>
<dt>
<span class="term">
<code class="literal">cfs_period_micros</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The period of time (in microseconds) for how regularly all tasks in the same
cgroup as the Elasticsearch process should have their access to CPU resources
reallocated.
</dd>
<dt>
<span class="term">
<code class="literal">cfs_quota_micros</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total amount of time (in microseconds) for which all tasks in
the same cgroup as the Elasticsearch process can run during one period
<code class="literal">cfs_period_micros</code>.
</dd>
<dt>
<span class="term">
<code class="literal">stat</code> (Linux only)
</span>
</dt>
<dd>
<p>
(object)
Contains CPU statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">stat</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">number_of_elapsed_periods</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The number of reporting periods (as specified by
<code class="literal">cfs_period_micros</code>) that have elapsed.
</dd>
<dt>
<span class="term">
<code class="literal">number_of_times_throttled</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The number of times all tasks in the same cgroup as the Elasticsearch process have
been throttled.
</dd>
<dt>
<span class="term">
<code class="literal">time_throttled_nanos</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total amount of time (in nanoseconds) for which all tasks in the same
cgroup as the Elasticsearch process have been throttled.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">memory</code> (Linux only)
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the <code class="literal">memory</code> control group for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">memory</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">control_group</code> (Linux only)
</span>
</dt>
<dd>
(string)
The <code class="literal">memory</code> control group to which the Elasticsearch process belongs.
</dd>
<dt>
<span class="term">
<code class="literal">limit_in_bytes</code> (Linux only)
</span>
</dt>
<dd>
(string)
The maximum amount of user memory (including file cache) allowed for all
tasks in the same cgroup as the Elasticsearch process. This value can be too big to
store in a <code class="literal">long</code>, so is returned as a string so that the value returned can
exactly match what the underlying operating system interface returns. Any
value that is too large to parse into a <code class="literal">long</code> almost certainly means no
limit has been set for the cgroup.
</dd>
<dt>
<span class="term">
<code class="literal">usage_in_bytes</code> (Linux only)
</span>
</dt>
<dd>
(string)
The total current memory usage by processes in the cgroup (in bytes) by all
tasks in the same cgroup as the Elasticsearch process. This value is stored as a
string for consistency with <code class="literal">limit_in_bytes</code>.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-process"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">process</code>
</span>
</dt>
<dd>
<p>
(object)
Contains process statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">process</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
Last time the statistics were refreshed. Recorded in milliseconds
since the <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix Epoch</a>.
</dd>
<dt>
<span class="term">
<code class="literal">open_file_descriptors</code>
</span>
</dt>
<dd>
(integer)
Number of opened file descriptors associated with the current  or
<code class="literal">-1</code> if not supported.
</dd>
<dt>
<span class="term">
<code class="literal">max_file_descriptors</code>
</span>
</dt>
<dd>
(integer)
Maximum number of file descriptors allowed on the system, or <code class="literal">-1</code> if not
supported.
</dd>
<dt>
<span class="term">
<code class="literal">cpu</code>
</span>
</dt>
<dd>
<p>
(object)
Contains CPU statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cpu</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">percent</code>
</span>
</dt>
<dd>
(integer)
CPU usage in percent, or <code class="literal">-1</code> if not known at the time the stats are
computed.
</dd>
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
CPU time used by the process on which the Java virtual machine is running.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_millis</code>
</span>
</dt>
<dd>
(integer)
CPU time (in milliseconds) used by the process on which the Java virtual
machine is running, or <code class="literal">-1</code> if not supported.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">mem</code>
</span>
</dt>
<dd>
<p>
(object)
Contains virtual memory statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mem</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total_virtual</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of virtual memory that is guaranteed to be available to the
running process.
</dd>
<dt>
<span class="term">
<code class="literal">total_virtual_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size in bytes of virtual memory that is guaranteed to be available to the
running process.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-jvm"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">jvm</code>
</span>
</dt>
<dd>
<p>
(object)
Contains Java Virtual Machine (JVM) statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">jvm</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
Last time JVM statistics were refreshed.
</dd>
<dt>
<span class="term">
<code class="literal">uptime</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
JVM uptime.
</dd>
<dt>
<span class="term">
<code class="literal">uptime_in_millis</code>
</span>
</dt>
<dd>
(integer)
JVM uptime in milliseconds.
</dd>
<dt>
<span class="term">
<code class="literal">mem</code>
</span>
</dt>
<dd>
<p>
(object)
Contains JVM memory usage statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mem</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">heap_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory currently in use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, currently in use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_used_percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of memory currently in use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_committed</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of memory available for use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_committed_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of memory, in bytes, available for use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Maximum amount of memory available for use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">heap_max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Maximum amount of memory, in bytes, available for use by the heap.
</dd>
<dt>
<span class="term">
<code class="literal">non_heap_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Non-heap memory used.
</dd>
<dt>
<span class="term">
<code class="literal">non_heap_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Non-heap memory used, in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">non_heap_committed</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Amount of non-heap memory available.
</dd>
<dt>
<span class="term">
<code class="literal">non_heap_committed_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount of non-heap memory available, in bytes.
</dd>
<dt>
<span class="term">
<code class="literal">pools</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about heap memory usage for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">pools</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">young</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory usage by the young generation heap for the
node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">young</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory used by the young generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, used by the young generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Maximum amount of memory available for use by the young generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Maximum amount of memory, in bytes, available for use by the young generation
heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Largest amount of memory historically used by the young generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Largest amount of memory, in bytes, historically used by the young generation
heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Largest amount of memory historically used by the young generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Largest amount of memory, in bytes, historically used by the young generation
heap.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">survivor</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory usage by the survivor space for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">survivor</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory used by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, used by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Maximum amount of memory available for use by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Maximum amount of memory, in bytes, available for use by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Largest amount of memory historically used by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Largest amount of memory, in bytes, historically used by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Largest amount of memory historically used by the survivor space.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Largest amount of memory, in bytes, historically used by the survivor space.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">old</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory usage by the old generation heap for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">old</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory used by the old generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, used by the old generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Maximum amount of memory available for use by the old generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Maximum amount of memory, in bytes, available for use by the old generation
heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Largest amount of memory historically used by the old generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Largest amount of memory, in bytes, historically used by the old generation
heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Highest memory limit historically available for use by the old generation heap.
</dd>
<dt>
<span class="term">
<code class="literal">peak_max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Highest memory limit, in bytes, historically available for use by the old
generation heap.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">threads</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM thread usage for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">threads</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of active threads in use by JVM.
</dd>
<dt>
<span class="term">
<code class="literal">peak_count</code>
</span>
</dt>
<dd>
(integer)
Highest number of threads used by JVM.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">gc</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM garbage collectors for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">gc</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">collectors</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM garbage collectors for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">collectors</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">young</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM garbage collectors that collect young generation
objects for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">young</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">collection_count</code>
</span>
</dt>
<dd>
(integer)
Number of JVM garbage collectors that collect young generation objects.
</dd>
<dt>
<span class="term">
<code class="literal">collection_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent by JVM collecting young generation objects.
</dd>
<dt>
<span class="term">
<code class="literal">collection_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds spent by JVM collecting young generation objects.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">old</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM garbage collectors that collect old generation
objects for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">old</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">collection_count</code>
</span>
</dt>
<dd>
(integer)
Number of JVM garbage collectors that collect old generation objects.
</dd>
<dt>
<span class="term">
<code class="literal">collection_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent by JVM collecting old generation objects.
</dd>
<dt>
<span class="term">
<code class="literal">collection_time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time in milliseconds spent by JVM collecting old generation objects.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">buffer_pools</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about JVM buffer pools for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">buffer_pools</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">mapped</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about mapped JVM buffer pools for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mapped</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of mapped buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of mapped buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of mapped buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">total_capacity</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total capacity of mapped buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">total_capacity_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total capacity, in bytes, of mapped buffer pools.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">direct</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about direct JVM buffer pools for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">direct</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of direct buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of direct buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of direct buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">total_capacity</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total capacity of direct buffer pools.
</dd>
<dt>
<span class="term">
<code class="literal">total_capacity_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total capacity, in bytes, of direct buffer pools.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">classes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about classes loaded by JVM for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">classes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">current_loaded_count</code>
</span>
</dt>
<dd>
(integer)
Number of classes currently loaded by JVM.
</dd>
<dt>
<span class="term">
<code class="literal">total_loaded_count</code>
</span>
</dt>
<dd>
(integer)
Total number of classes loaded since the JVM started.
</dd>
<dt>
<span class="term">
<code class="literal">total_unloaded_count</code>
</span>
</dt>
<dd>
(integer)
Total number of classes unloaded since the JVM started.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-threadpool"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">thread_pool</code>
</span>
</dt>
<dd>
<p>
(object)
Contains thread pool statistics for the node
</p>
<details open>
<summary class="title">Properties of <code class="literal">thread_pool</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;thread_pool_name&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the thread pool for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;thread_pool_name&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">threads</code>
</span>
</dt>
<dd>
(integer)
Number of threads in the thread pool.
</dd>
<dt>
<span class="term">
<code class="literal">queue</code>
</span>
</dt>
<dd>
(integer)
Number of tasks in queue for the thread pool.
</dd>
<dt>
<span class="term">
<code class="literal">active</code>
</span>
</dt>
<dd>
(integer)
Number of active threads in the thread pool.
</dd>
<dt>
<span class="term">
<code class="literal">rejected</code>
</span>
</dt>
<dd>
(integer)
Number of tasks rejected by the thread pool executor.
</dd>
<dt>
<span class="term">
<code class="literal">largest</code>
</span>
</dt>
<dd>
(integer)
Highest number of active threads in the thread pool.
</dd>
<dt>
<span class="term">
<code class="literal">completed</code>
</span>
</dt>
<dd>
(integer)
Number of tasks completed by the thread pool executor.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-fs"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">fs</code>
</span>
</dt>
<dd>
<p>
(object)
Contains file store statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">fs</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
Last time the file stores statistics were refreshed. Recorded in
milliseconds since the <a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix Epoch</a>.
</dd>
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for all file stores of the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">total</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total size of all file stores.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size (in bytes) of all file stores.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total unallocated disk space in all file stores.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total number of unallocated bytes in all file stores.
</dd>
<dt>
<span class="term">
<code class="literal">available</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total disk space available to this Java virtual machine on all file
stores. Depending on OS or process level restrictions, this might appear
less than <code class="literal">free</code>. This is the actual amount of free disk
space the Elasticsearch node can utilise.
</dd>
<dt>
<span class="term">
<code class="literal">available_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total number of bytes available to this Java virtual machine on all file
stores. Depending on OS or process level restrictions, this might appear
less than <code class="literal">free_in_bytes</code>. This is the actual amount of free disk
space the Elasticsearch node can utilise.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">least_usage_estimate</code>
</span>
</dt>
<dd>
(object)
Contains statistics for the file store with the least estimated usage. See
<a class="xref" href="cluster-nodes-stats.html#cluster-nodes-stats-fs-data"><code class="literal">fs.data</code></a> for a list of child parameters.
</dd>
<dt>
<span class="term">
<code class="literal">most_usage_estimate</code>
</span>
</dt>
<dd>
(object)
Contains statistics for the file store with the most estimated usage. See
<a class="xref" href="cluster-nodes-stats.html#cluster-nodes-stats-fs-data"><code class="literal">fs.data</code></a> for a list of child parameters.
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-fs-data"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">data</code>
</span>
</dt>
<dd>
<p>
(array of objects)
List of all file stores.
</p>
<details open>
<summary class="title">Properties of <code class="literal">data</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">path</code>
</span>
</dt>
<dd>
(string)
Path to the file store.
</dd>
<dt>
<span class="term">
<code class="literal">mount</code>
</span>
</dt>
<dd>
<p>
(string)
Mount point of the file store (ex: /dev/sda2).
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This parameter is not provided for the <code class="literal">least_usage_estimate</code> or
<code class="literal">most_usage_estimate</code> file stores.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">type</code>
</span>
</dt>
<dd>
(string)
Type of the file store (ex: ext4).
</dd>
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total size of the file store.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size (in bytes) of the file store.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of unallocated disk space in the file store.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total number of unallocated bytes in the file store.
</dd>
<dt>
<span class="term">
<code class="literal">available</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Total amount of disk space available to this Java virtual machine on this file
store.
</dd>
<dt>
<span class="term">
<code class="literal">available_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total number of bytes available to this Java virtual machine on this file
store.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">io_stats</code> (Linux only)
</span>
</dt>
<dd>
<p>
(objects)
Contains I/O statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">io_stats</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">devices</code> (Linux only)
</span>
</dt>
<dd>
<p>
(array)
Array of disk metrics for each device that is backing an Elasticsearch data path.
These disk metrics are probed periodically and averages between the last
probe and the current probe are computed.
</p>
<details open>
<summary class="title">Properties of <code class="literal">devices</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">device_name</code> (Linux only)
</span>
</dt>
<dd>
(string)
The Linux device name.
</dd>
<dt>
<span class="term">
<code class="literal">operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of read and write operations for the device completed since
starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">read_operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of read operations for the device completed since starting
Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">write_operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of write operations for the device completed since starting
Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">read_kilobytes</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of kilobytes read for the device since starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">write_kilobytes</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of kilobytes written for the device since starting Elasticsearch.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of read and write operations across all devices used by
Elasticsearch completed since starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">read_operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of read operations for across all devices used by Elasticsearch
completed since starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">write_operations</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of write operations across all devices used by Elasticsearch
completed since starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">read_kilobytes</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of kilobytes read across all devices used by Elasticsearch since
starting Elasticsearch.
</dd>
<dt>
<span class="term">
<code class="literal">write_kilobytes</code> (Linux only)
</span>
</dt>
<dd>
(integer)
The total number of kilobytes written across all devices used by Elasticsearch since
starting Elasticsearch.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-transport"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">transport</code>
</span>
</dt>
<dd>
<p>
(object)
Contains transport statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">transport</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">server_open</code>
</span>
</dt>
<dd>
(integer)
Number of open TCP connections used for internal communication between nodes.
</dd>
<dt>
<span class="term">
<code class="literal">rx_count</code>
</span>
</dt>
<dd>
(integer)
Total number of RX (receive) packets received by the node during internal
cluster communication.
</dd>
<dt>
<span class="term">
<code class="literal">rx_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of RX packets received by the node during internal cluster communication.
</dd>
<dt>
<span class="term">
<code class="literal">rx_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of RX packets received by the node during internal cluster
communication.
</dd>
<dt>
<span class="term">
<code class="literal">tx_count</code>
</span>
</dt>
<dd>
(integer)
Total number of TX (transmit) packets sent by the node during internal cluster
communication.
</dd>
<dt>
<span class="term">
<code class="literal">tx_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Size of TX packets sent by the node during internal cluster communication.
</dd>
<dt>
<span class="term">
<code class="literal">tx_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Size, in bytes, of TX packets sent by the node during internal cluster
communication.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-http"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">http</code>
</span>
</dt>
<dd>
<p>
(object)
Contains http statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">http</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">current_open</code>
</span>
</dt>
<dd>
(integer)
Current number of open HTTP connections for the node.
</dd>
<dt>
<span class="term">
<code class="literal">total_opened</code>
</span>
</dt>
<dd>
(integer)
Total number of HTTP connections opened for the node.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-breakers"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">beakers</code>
</span>
</dt>
<dd>
<p>
(object)
Contains circuit breaker statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">breakers</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;circuit_breaker_name&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the circuit breaker.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;circuit_breaker_name&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">limit_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory limit, in bytes, for the circuit breaker.
</dd>
<dt>
<span class="term">
<code class="literal">limit_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Memory limit for the circuit breaker.
</dd>
<dt>
<span class="term">
<code class="literal">estimated_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Estimated memory used, in bytes, for the operation.
</dd>
<dt>
<span class="term">
<code class="literal">estimated_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte value</a>)
Estimated memory used for the operation.
</dd>
<dt>
<span class="term">
<code class="literal">overhead</code>
</span>
</dt>
<dd>
(float)
A constant that all estimates for the circuit breaker are multiplied with to
calculate a final estimate.
</dd>
<dt>
<span class="term">
<code class="literal">tripped</code>
</span>
</dt>
<dd>
(integer)
Total number of times the circuit breaker has been triggered and prevented an
out of memory error.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-script"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">script</code>
</span>
</dt>
<dd>
<p>
(object)
Contains script statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">script</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">compilations</code>
</span>
</dt>
<dd>
(integer)
Total number of inline script compilations performed by the node.
</dd>
<dt>
<span class="term">
<code class="literal">cache_evictions</code>
</span>
</dt>
<dd>
(integer)
Total number of times the script cache has evicted old data.
</dd>
<dt>
<span class="term">
<code class="literal">compilation_limit_triggered</code>
</span>
</dt>
<dd>
(integer)
Total number of times the <a class="xref" href="circuit-breaker.html#script-compilation-circuit-breaker" title="Script compilation circuit breaker">script
compilation</a> circuit breaker has limited inline script compilations.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-discovery"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">discovery</code>
</span>
</dt>
<dd>
<p>
(object)
Contains node discovery statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">discovery</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">cluster_state_queue</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the cluster state queue of the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cluster_state_queue</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of cluster states in queue.
</dd>
<dt>
<span class="term">
<code class="literal">pending</code>
</span>
</dt>
<dd>
(integer)
Number of pending cluster states in queue.
</dd>
<dt>
<span class="term">
<code class="literal">committed</code>
</span>
</dt>
<dd>
(integer)
Number of committed cluster states in queue.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">published_cluster_states</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the published cluster states of the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">published_cluster_states</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">full_states</code>
</span>
</dt>
<dd>
(integer)
Number of published cluster states.
</dd>
<dt>
<span class="term">
<code class="literal">incompatible_diffs</code>
</span>
</dt>
<dd>
(integer)
Number of incompatible differences between published cluster states.
</dd>
<dt>
<span class="term">
<code class="literal">compatible_diffs</code>
</span>
</dt>
<dd>
(integer)
Number of compatible differences between published cluster states.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-ingest"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">ingest</code>
</span>
</dt>
<dd>
<p>
(object)
Contains ingest statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">ingest</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about ingest operations for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">total</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Total number of documents ingested during the lifetime of this node.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent preprocessing ingest documents during the lifetime of this
node.
</dd>
<dt>
<span class="term">
<code class="literal">time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time, in milliseconds, spent preprocessing ingest documents during the
lifetime of this node.
</dd>
<dt>
<span class="term">
<code class="literal">current</code>
</span>
</dt>
<dd>
(integer)
Total number of documents currently being ingested.
</dd>
<dt>
<span class="term">
<code class="literal">failed</code>
</span>
</dt>
<dd>
(integer)
Total number of failed ingest operations during the lifetime of this node.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">pipelines</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about ingest pipelines for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">pipelines</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;pipeline_id&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the ingest pipeline.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;pipeline_id&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of documents preprocessed by the ingest pipeline.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Total time spent preprocessing documents in the ingest pipeline.
</dd>
<dt>
<span class="term">
<code class="literal">time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Total time, in milliseconds, spent preprocessing documents in the ingest
pipeline.
</dd>
<dt>
<span class="term">
<code class="literal">failed</code>
</span>
</dt>
<dd>
(integer)
Total number of failed operations for the ingest pipeline.
</dd>
<dt>
<span class="term">
<code class="literal">processors</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics for the ingest processors for the ingest pipeline.
</p>
<details open>
<summary class="title">Properties of <code class="literal">processors</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;processor&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for the ingest processor.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;processor&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of documents transformed by the processor.
</dd>
<dt>
<span class="term">
<code class="literal">time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Time spent by the processor transforming documents.
</dd>
<dt>
<span class="term">
<code class="literal">time_in_millis</code>
</span>
</dt>
<dd>
(integer)
Time, in milliseconds, spent by the processor transforming documents.
</dd>
<dt>
<span class="term">
<code class="literal">current</code>
</span>
</dt>
<dd>
(integer)
Number of documents currently being transformed by the processor.
</dd>
<dt>
<span class="term">
<code class="literal">failed</code>
</span>
</dt>
<dd>
(integer)
Number of failed operations for the processor.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-nodes-stats-api-response-body-adaptive-selection"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">adaptive_selection</code>
</span>
</dt>
<dd>
<p>
(object)
Contains adaptive selection statistics for the node.
</p>
<details open>
<summary class="title">Properties of <code class="literal">adaptive_selection</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">outgoing_searches</code>
</span>
</dt>
<dd>
(integer)
The number of outstanding search requests from the node these stats are for
to the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">avg_queue_size</code>
</span>
</dt>
<dd>
(integer)
The exponentially weighted moving average queue size of search requests on
the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">avg_service_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
The exponentially weighted moving average service time of search requests on
the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">avg_service_time_ns</code>
</span>
</dt>
<dd>
(integer)
The exponentially weighted moving average service time, in nanoseconds, of
search requests on the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">avg_response_time</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
The exponentially weighted moving average response time of search requests
on the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">avg_response_time_ns</code>
</span>
</dt>
<dd>
(integer)
The exponentially weighted moving average response time, in nanoseconds, of
search requests on the keyed node.
</dd>
<dt>
<span class="term">
<code class="literal">rank</code>
</span>
</dt>
<dd>
(string)
The rank of this node; used for shard selection when routing search
requests.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-nodes-stats-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console"># return just indices
GET /_nodes/stats/indices

# return just os and process
GET /_nodes/stats/os,process

# return just process for node with IP address 10.0.0.1
GET /_nodes/10.0.0.1/stats/process</pre>
</div>
<div class="console_widget" data-snippet="snippets/1408.console"></div>
<p>All stats can be explicitly requested via <code class="literal">/_nodes/stats/_all</code> or
<code class="literal">/_nodes/stats?metric=_all</code>.</p>
<p>You can get information about indices stats on <code class="literal">node</code>, <code class="literal">indices</code>, or <code class="literal">shards</code>
level.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console"># Fielddata summarized by node
GET /_nodes/stats/indices/fielddata?fields=field1,field2

# Fielddata summarized by node and index
GET /_nodes/stats/indices/fielddata?level=indices&amp;fields=field1,field2

# Fielddata summarized by node, index, and shard
GET /_nodes/stats/indices/fielddata?level=shards&amp;fields=field1,field2

# You can use wildcards for field names
GET /_nodes/stats/indices/fielddata?fields=field*</pre>
</div>
<div class="console_widget" data-snippet="snippets/1409.console"></div>
<p>You can get statistics about search groups for searches executed
on this node.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console"># All groups with all stats
GET /_nodes/stats?groups=_all

# Some groups from just the indices stats
GET /_nodes/stats/indices?groups=foo,bar</pre>
</div>
<div class="console_widget" data-snippet="snippets/1410.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cluster-nodes-stats-ingest-ex"></a>Retrieve ingest statistics only<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/nodes-stats.asciidoc">edit</a>
</h4>
</div></div></div>
<p>To return only ingest-related node statistics, set the <code class="literal">&lt;metric&gt;</code> path
parameter to <code class="literal">ingest</code> and use the
<a class="xref" href="common-options.html#common-options-response-filtering" title="Response Filtering"><code class="literal">filter_path</code></a> query parameter.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_nodes/stats/ingest?filter_path=nodes.*.ingest</pre>
</div>
<div class="console_widget" data-snippet="snippets/1411.console"></div>
<p>You can use the <code class="literal">metric</code> and <code class="literal">filter_path</code> query parameters to get the same
response.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_nodes/stats?metric=ingest&amp;filter_path=nodes.*.ingest</pre>
</div>
<div class="console_widget" data-snippet="snippets/1412.console"></div>
<p>To further refine the response, change the <code class="literal">filter_path</code> value.
For example, the following request only returns ingest pipeline statistics.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_nodes/stats?metric=ingest&amp;filter_path=nodes.*.ingest.pipelines</pre>
</div>
<div class="console_widget" data-snippet="snippets/1413.console"></div>
</div>

</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cluster-nodes-reload-secure-settings.html">« Nodes reload secure settings API</a>
</span>
<span class="next">
<a href="cluster-pending.html">Pending cluster tasks API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
